GET ALL

Query all EyeLevel customer accounts that are associated with the given partner API key

QUERY ALL (PARTNER)

GET https://api.eyelevel.ai/v1/partner/customer

Query Parameters

NameTypeDescription

n

integer

Number of results per query

page

integer

Current pagination number

{ 
    "count": "INTEGER",
    "customers": [
        {
            "apiKey":       "STRING IDENTIFIER",
            "email":        "STRING",
            "first":        "STRING",
            "last":         "STRING",
            "phone":        "STRING",
            "company":      "STRING",
            "companyUrl":   "STRING"
        }
    ],
    "lastPage": "INTEGER",
    "nextPage": "INTEGER",
}

Request

n

OPTIONAL - Integer

Validation: Minimum = 1 Maximum = 100 Default = 20

The number of results you want per request.

page

OPTIONAL - Integer

The pagination number for the request. Values for this parameter are included as lastPage and nextPage in query results.

Response

{ 
    "count": "INTEGER",
    "customers": [
        {
            "apiKey":       "STRING IDENTIFIER",
            "email":        "STRING",
            "first":        "STRING",
            "last":         "STRING",
            "phone":        "STRING",
            "company":      "STRING",
            "companyUrl":   "STRING"
        }
    ],
    "lastPage": "INTEGER",
    "nextPage": "INTEGER",
}

apiKey

The unique EyeLevel customer API key for the customer.

company

The company name associated with EyeLevel customer account.

companyUrl

The company website URL associated with EyeLevel customer account.

count

The number of results in the response.

email

The email address associated with EyeLevel customer account.

first

The given name of the EyeLevel customer.

last

The family name of the EyeLevel customer.

lastPage

The pagination number for the previous set of query results when there are more results than n. This value can be used with the page parameter to query for the previous set of results.

nextPage

The pagination number for the next set of query results when there are more results than n. This value can be used with the page parameter to query for the next set of results.

phone

The phone number associated with the EyeLevel customer account.

Objects

Last updated