Skip to main content

List Agents

GET 
/agents

List Agents

Request​

Query Parameters

    limit number

    Number of items to return

    offset number

    Number of items to skip

    filter.type string

    Type

    filter.name string

    Name

    filter.primaryEmail string

    Email

    filter.primaryPhone string

    Phone

    filter.firstName string

    First Name

    filter.lastName string

    Last Name

    filter.nickname string

    Nickname

    filter.gender string

    Gender

    filter.dateOfBirth string

    Date of Birth

    filter.lastActive string

    Last Active

    filter.id string

    Id

    filter.tags string

    Tags

    filter.createdAt string

    Created At

    filter.updatedAt string

    Updated At

    filter.deletedAt string

    Deleted At

    filter.deleted string

    Deleted

    filter.createdBy string

    Created By

    filter.updatedBy string

    Updated By

    filter.deletedBy string

    Deleted By

    filter.status string

    Status

    filter.age number

    Age

    filter.fullName string

    Full Name

    filter.clientId string

    ID

    filter.address1 string

    Address 1

    filter.address2 string

    Address 2

    filter.address3 string

    Address 3

    filter.city string

    City

    filter.region string

    State

    filter.postalCode string

    Postal Code

    filter.country string

    Country

    include string[]

    Possible values: [type, name, primaryEmail, primaryPhone, firstName, lastName, nickname, gender, dateOfBirth, lastActive, id, tags, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy, status, age, fullName, clientId, address1, address2, address3, city, region, postalCode, country]

Responses​

List of Agents

Schema

  • Array [

    • type string

    Type

    name string

    Name

    primaryEmail string

    Email

    primaryPhone string

    Phone

    firstName string

    First Name

    lastName string

    Last Name

    nickname string

    Nickname

    gender string

    Gender

    Possible values: [Male, Female, Other]

    dateOfBirth string

    Date of Birth

    tags string

    Tags

    address1 string

    Address 1

    address2 string

    Address 2

    address3 string

    Address 3

    city string

    City

    region string

    State

    postalCode string

    Postal Code

    country string

    Country

    lastActive string

    Last Active

    id string

    Id

    createdAt string

    Created At

    updatedAt string

    Updated At

    deletedAt string

    Deleted At

    deleted string

    Deleted

    createdBy string

    Created By

    updatedBy string

    Updated By

    deletedBy string

    Deleted By

    status string

    Status

    age number

    Age

    fullName string

    Full Name

    clientId string

    ID

  • ]

Loading...