v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Providers

Search providers

Search for one or more providers.

get/v1/Providers

Query parameters

search.provider_idinteger[]

Query by provider identifier.

search.descriptionstring[]

Query by all or part of provider description.

search.provider_codestring[]

Query by programmatic code.

search.gravity_profile_idinteger[]

Query by gravity profile identifier.

search.state_provincestring[]

Query state restriction (2-character abbreviation).

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Return only entries created after this date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Return only entries created before this date.

search.created_byinteger[]

Query by user identifier (who created it).

search.modified_date_startstring date-time

Format - date-time (as date-time in RFC3339). Return only entries modified after this date.

search.modified_date_endstring date-time

Format - date-time (as date-time in RFC3339). Return only entries modified before this date.

search.modified_byinteger[]

Query by user identifier (who changed it).

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.