ContactSocialRelations.list

Returns all defined ContactSocialRelations

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted ContactSocialRelations are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of ContactSocialRelations

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (ContactSocialRelation) {32}]

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity. Must match with Contact id.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

angellist_url

string

optional

URL - HTTP address.

Example:

string

crunchbase_url

string

optional

URL - HTTP address.

Example:

string

disqus_url

string

optional

URL - HTTP address.

Example:

string

facebook_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

facebook_url

string

optional

URL - HTTP address.

Example:

string

flickr_url

string

optional

URL - HTTP address.

Example:

string

foursquare_url

string

optional

URL - HTTP address.

Example:

string

google_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

google_plus_url

string

optional

URL - HTTP address.

Example:

string

gravatar_url

string

optional

URL - HTTP address.

Example:

string

klout_url

string

optional

URL - HTTP address.

Example:

string

linkedin_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

linkedin_url

string

optional

URL - HTTP address.

Example:

string

pinterest_url

string

optional

URL - HTTP address.

Example:

string

quora_url

string

optional

URL - HTTP address.

Example:

string

reddit_url

string

optional

URL - HTTP address.

Example:

string

skype_url

string

optional

URL - HTTP address.

Example:

string

slideshare_url

string

optional

URL - HTTP address.

Example:

string

twitter_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

twitter_url

string

optional

URL - HTTP address.

Example:

string

vimeo_url

string

optional

URL - HTTP address.

Example:

string

wordpress_url

string

optional

URL - HTTP address.

Example:

string

xing_url

string

optional

URL - HTTP address.

Example:

string

yahoo_url

string

optional

URL - HTTP address.

Example:

string

yelp_url

string

optional

URL - HTTP address.

Example:

string

youtube_url

string

optional

URL - HTTP address.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
  "success": true,
  "data": [
    {
      "is_delete_protected": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "angellist_url": "string",
      "crunchbase_url": "string",
      "disqus_url": "string",
      "facebook_id": "string",
      "facebook_url": "string",
      "flickr_url": "string",
      "foursquare_url": "string",
      "google_id": "string",
      "google_plus_url": "string",
      "gravatar_url": "string",
      "klout_url": "string",
      "linkedin_id": "string",
      "linkedin_url": "string",
      "pinterest_url": "string",
      "quora_url": "string",
      "reddit_url": "string",
      "skype_url": "string",
      "slideshare_url": "string",
      "twitter_id": "string",
      "twitter_url": "string",
      "vimeo_url": "string",
      "wordpress_url": "string",
      "xing_url": "string",
      "yahoo_url": "string",
      "yelp_url": "string",
      "youtube_url": "string",
      "revision": 1
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

🔴500Server Error

ContactSocialRelations.list

Request

Request samples

Responses