List Objects

List objects.

Endpoint

GET /v2/objects

Request

Query Params

---

objectType string, optional

Only return objects with an objectType matching this value.

---

This endpoint supports all of the query parameters specified in the Pagination & Sorting section. Supported values for the sortBy parameter are objectType, objectId, and createdAt.

---

cURL

GET /v2/objects

curl "https://api.warrant.dev/v2/objects?objectType=user" \
    -H "Authorization: ApiKey YOUR_KEY"

Go

GET /v2/objects

objects, err := objects.List(&warrant.ListObjectParams{
    ListParams: warrant.ListParams{
        Limit: 10,
    },
})

Java

GET /v2/objects

BaseListResult objects = client.listObjects(new ObjectFilters(), new ListParams().withLimit(10));

Node.js

GET /v2/objects

const objects = warrantClient.Object.list({ limit: 10 });

Python

GET /v2/objects

objects = warrant.Object.list()

Ruby

GET /v2/objects

objects = Warrant::Object.list()

Response

Body

---

results array

A list of objects.

---

prevCursor string

This attribute will be omitted from the response if there are no previous results to fetch.

---

nextCursor string

This attribute will be omitted from the response if there are no more results to fetch.

---

200 OK

{
    "results": [
        {
            "objectType": "user",
            "objectId": "newUser2",
            "meta": {
              "email": "email2@userid.com"
            }
        },
        {
            "objectType": "user",
            "objectId": "email@userid.com",
            "meta": {
              "email": "email@userid.com"
            }
        },
        {
            "objectType": "user",
            "objectId": "04a2f51d-f3ce-4fa7-8aa6-26cc802d236e"
        },
        {
            "objectType": "user",
            "objectId": "user1"
        }
    ]
}