1. v3
  2. Lookup
  3. GET - 3/lookup/contactstatus

Definition

GET - 3/lookup/contactstatus?lang={lang}

Retrieve the contact status id and name for all possible contact statuses. The data will be retrieved in the requested language. The possible statuses are discussed in our knowledgebase.

Used in Contact - ContactStatusId,

Response cached for 86400 seconds.

1 Included
2 Invited
3 Reminded
4 Partially responded
5 Responded completely
6 Dropped
7 Declined
8 Paused
9 Bounced
13 Screened out
15 Not delivered
16 Quota full
19 Expired

Request information

lang

The two-letter code of the requested language, if not available we will use english


Type string
Additional info
Optional

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of SimpleLookup
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-11-21T11:45:11.0861341Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <SimpleLookup z:Id="i2">
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </SimpleLookup>
    <SimpleLookup z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-21T11:45:11.0861341+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>