List contacts - Slash

GET

/

v2

/

contacts

List contacts

curl --request GET \
  --url https://api.slash.com/v2/contacts \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/contacts"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/contacts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "recipientType": "contact",
      "recipientLegalName": "<string>",
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "recipientEmail": "jsmith@example.com",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>"
      },
      "archivedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "count": 1,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

cursor

string

Pass the opaque value returned in metadata.nextCursor without changing the other query parameters.

search

string

Search by contact name, id, or email.

recipientType

enum<string>

Return only people or only vendors.

Available options:

contact,

vendor

includeArchived

boolean

default:false

Include archived contacts. Defaults to false.

Response

A page of contacts.

items

Contact · object[]

required

Hide child attributes

items.id

string

required

Contact id with the le_c_ prefix.

items.name

string

required

Display name visible to your organization.

items.recipientType

enum<string>

required

Available options:

contact,

vendor

items.recipientLegalName

string

required

items.status

enum<string>

required

Available options:

active,

archived

items.createdAt

string<date-time>

required

items.recipientEmail

string<email>

items.address

Address · object

Hide child attributes

items.address.line1

string

required

Minimum string length: 1

items.address.city

string

required

Minimum string length: 1

items.address.line2

string

items.address.state

string

items.address.postalCode

string

items.address.countryCode

string

ISO 3166-1 alpha-2 country code.

Required string length: 2

items.archivedAt

string<date-time>

metadata

PaginationMetadata · object

required

Hide child attributes

metadata.count

integer

required

Number of items in this page.

Required range: x >= 0

metadata.nextCursor

string

Opaque cursor for the next page. Omitted on the final page.

⌘I

List contacts

curl --request GET \
  --url https://api.slash.com/v2/contacts \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/contacts"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/contacts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "recipientType": "contact",
      "recipientLegalName": "<string>",
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "recipientEmail": "jsmith@example.com",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>"
      },
      "archivedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "count": 1,
    "nextCursor": "<string>"
  }
}