GET
/
api
/
v1
/
groups
/
{group_id}
/
contacts
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/contacts
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 2
  },
  "response": [
    {
      "created": 1557512389,
      "email": "davidsmith@testcorp.com",
      "first_name": "David",
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e",
      "last_name": "Smith",
      "modified": 1543215342,
      "phone_number": "+14255551234",
      "primary_contact": true,
      "title": "Chief People Officer",
      "types": [
        "company",
        "billing"
      ],
      "version": "6ba43c6e-69f2-435f-a126-8595a798eb52"
    },
    {
      "created": 1557512389,
      "email": "carolinejohnson@testcorp.com",
      "first_name": "Caroline",
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "7e3c1f14-e7e7-42b8-81d8-3fcd7bd7d418",
      "last_name": "Johnson",
      "modified": 1543215342,
      "phone_number": "+14255551234",
      "primary_contact": false,
      "title": "VP of Human Resources",
      "types": [
        "executive"
      ],
      "version": "88bfbe28-7f8b-4497-a50b-932ee3387b68"
    }
  ]
}

Path Parameters

​
group_id
string
required

The unique identifier of the group for which you would like to view contacts

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Query Parameters

​
page_size
integer

The max size of each page of results

​
offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

Response

200 - application/json
Successful Response - Returns all matching Group Contacts
​
meta
object
required

Metadata associated with the response data

​
response
object[]
required

List of contact results

Was this page helpful?