List Contacts - BlinkOps Documentation

Get a list of contacts with optional filtering.

External DocumentationTo learn more, visit the Oracle Service Cloud documentation.

Basic Parameters

Parameter	Description
Application Context	The application context information to attach as `OSvC-CREST-Application-Context` request header. For more information, please refer to Oracle documentation.
Fields	A comma-separated list of attributes to return for each object in the response.
Limit	The maximum number of results to return per page.
Offset	The pagination offset indicating the starting point for the next set of results.
Order By	A comma-separated list of attributes and order, used to determine the order in which the records are returned.
Return All Pages	Automatically fetch all resources, page by page.
Search Query	The ROQL to filter the results by. For more information, please refer to Oracle’s documentation.
Total Results	Select whether to return the total count of available results.

Advanced Parameters

Parameter	Description
Next Request After	The time (in milliseconds) that must elapse before subsequent API calls will be executed. This value will be attached as `osvc-crest-next-request-after` request header. For more information, please refer to Oracle documentation.

Example Output

{
	"items": [
		{
			"id": 2,
			"lookupName": "Susan Meadows",
			"createdTime": "2013-08-21T20:30:18Z",
			"updatedTime": "2013-08-21T21:02:09Z",
			"links": [
				{
					"rel": "canonical",
					"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/2"
				}
			]
		},
		{
			"id": 3,
			"lookupName": "George Langston",
			"createdTime": "2013-08-21T20:31:10Z",
			"updatedTime": "2013-08-21T21:04:22Z",
			"links": [
				{
					"rel": "canonical",
					"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/3"
				}
			]
		},
		{
			"id": 82,
			"lookupName": "Calvin Hobbes",
			"createdTime": "2015-09-29T20:15:35Z",
			"updatedTime": "2015-09-29T20:15:35Z",
			"links": [
				{
					"rel": "canonical",
					"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/82"
				}
			]
		}
	],
	"hasMore": false,
	"links": [
		{
			"rel": "canonical",
			"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts"
		},
		{
			"rel": "describedby",
			"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contacts",
			"mediaType": "application/schema+json"
		},
		{
			"rel": "self",
			"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts"
		}
	]
}