Skip to main content
GET
/
api
/
v1
/
providers
/
search
Search for insurance providers
curl --request GET \
  --url https://dev.superpool.unyte.africa/api/v1/providers/search/ \
  --header 'X-API-Key: <api-key>'
{
  "count": 100,
  "next": "http://http://localhost:8000/api/v1/providers/?name=example&limit=25&offset=25",
  "previous": "null",
  "results": [
    {
      "id": "e1a5d88c-4b23-4b90-8e7a-b3fef95e3a80",
      "name": "Acme Insurance Co.",
      "address": "123 Elm Street, Springfield, IL",
      "phone_number": "+1-800-555-1234"
    },
    {
      "id": "d8e9d79a-d1c1-4f07-b6d8-7399be13b47e",
      "name": "Globex Corporation",
      "address": "456 Oak Avenue, Metropolis, NY",
      "phone_number": "+1-800-555-5678"
    },
    {
      "id": "ff7b7b3c-2df9-4b93-9f2e-9bde4b7a40da",
      "name": "Initech Insurance",
      "address": "789 Pine Road, Silicon Valley, CA",
      "phone_number": "+1-800-555-9876"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer

The number of results to return per page

name
string

The name of the insurance provider

offset
integer

The starting position of results to return

Response

List of insurance providers

provider_id
string<uuid>
required
provider_name
string
required
support_email
string<email> | null
required

Email address is used to track their support team during integrations

support_phone
string | null
required

Phone number of the insurance provider's support team

products_offered
object[]
required