List Contacts
Gets a list of the user's Smartsheet contacts.
query Parameters
| includeAll | boolean Default: false If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified). |
string or number When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version. | |
| numericDates | boolean Default: false You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request. |
| page | number Default: 1 Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, you'll receive an empty data set. |
| pageSize | number Default: 100 The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request. |
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/contacts \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
Response samples
- 200
- 401
- 404
- 500
{- "pageNumber": 1,
- "pageSize": 50,
- "totalPages": 25,
- "totalCount": 136,
- "data": [
- {
- "id": "AAAAATYU54QAD7_fNhTnhA",
- "name": "Jane Doe",
- "email": "jane.doe@smartsheet.com"
}
]
}Get Contact
Gets the specified contact.
path Parameters
| contactId required | number contactId of the contact being accessed. |
query Parameters
| include | string A comma-separated list of optional elements to include in the response:
|
header Parameters
| Authorization | string API Access Token used to authenticate requests to Smartsheet APIs. Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789 |
Responses
Request samples
- cURL
- C#
- Java
- Node.js
- Python
- Ruby
curl https://api.smartsheet.com/2.0/contacts/{contactId} \ -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"
Response samples
- 200
- default
{- "id": "AAAAATYU54QAD7_fNhTnhA",
- "name": "Jane Doe",
- "email": "jane.doe@smartsheet.com"
}