Develop > Application Programming Interface > Legacy APIs > Search API

Search API

Details

URI /search
Method GET
Parameters

userIdentifier=<user_id>
    Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.

query=<string>
    Required; returns search results that contain string in their display name or description.

type=[all|subscription|service_offering|service_request|approval_process]
    Optional; default is all. The type of objects to search.
Returns 200 - Ok
401 - Not authorized
404 - Not found
500 - Server exception

Send Help Center feedback