Skip to main content
GET
/
contact
/
list
Python
from superu import SuperU

client = SuperU("YOUR_SUPERU_API_KEY")

payload = {
    "page": "1",
    "limit": "10",
    "search_query": "ava"
}

response = client.contacts.list(**payload)
print(response)
{
  "status": "success",
  "contact_list": [
    {
      "contact_id": "con_01HXR9N8QCYHTWNB5JX22P4QZA",
      "first_name": "Ava",
      "phone_number": "5551234567"
    }
  ],
  "page": 1,
  "limit": 10
}

Authorizations

superU-Api-Key
string
header
required

Your SuperU API key.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
Example:

1

limit
integer
default:10

Contacts per page (1-100)

Required range: 1 <= x <= 100
Example:

10

search_query
string

Search text

Example:

"ava"

Response

Contacts returned

Generic Response schema.

status
string

Status value.

Example:

"success"

message
string

Message value.

Example:

"Request completed successfully"

data
object

Data value.