List all providers

GET /api/v1/providers

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Filter by a comma separated list of partial provider names.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to '-created_at'.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
GET /api/v1/providers 
curl \
 -X GET https://api.plannrcrm.com/api/v1/providers \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "AJ Bell",
      "slug": "aj-bell",
      "uuid": "e25ab000-87c9-4c4f-bebc-7aee0dcd4504",
      "created_at": "2024-11-20T13:23:58+00:00",
      "updated_at": "2024-11-20T13:23:58+00:00"
    }
  ]
}