Prospects

List All Prospects

List All Prospects

get/v1/prospects

Request

  • Base URL
    https://api.trata.ai
  • URL
    https://api.trata.ai/v1/prospects
  • Auth
    HTTP bearer

Query parameters

search_bystring nullable

Field name to search by

search_valuestring nullable

Value to search for in the specified field

statusstring nullable

Filter by status

sort_bystring nullable

Field to sort by

sort_order'asc' | 'desc'

Sort order (asc or desc)

skipinteger

Number of records to skip

limitinteger

Maximum number of records to return

Response

List of prospects retrieved successfully

idstring required
orgIdstring
namestring nullable
emailstring nullable
phoneNumberstring nullable
statusstring required
prospectPropsobject nullable required
createdBystring
createdAtstring date-time
updatedBystring
updatedAtstring date-time

Example response

[
  {
    "externalReference": [
      {
        "providerName": "Google Analytics",
        "id": "GA-123456"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.