GET v1.3/accounts
Lists the accounts that the access token can manipulate. In the current version of the API each token can only manipulate one account.
This resource supports additional data through the fields parameter
Parameters
Label | Description | Values | Modifiers | Type | Required |
---|---|---|---|---|---|
id | The unique id of an account or accounts to access e.g v1.3/accounts?id=2&id=1 |
an account id | none | query string | false |
name | The name of an account to access e.g v1.3/accounts?name=test_account |
an account name | none | query string | false |
fields | Return additional data about this resource e.g v1.3/accounts?fields=url,reports,id,channels |
url, reports, id, channels, description, package, created_date, name | none | query string | false |
created_date | return an account resource by created date e.g v1.3/accounts?created_date=2014-01-01 |
ISO Date | gte, lte, lt, lte | query string | false |
GET v1.3/accounts/:id
Information about one account, including name, channels, and reports.
This resource supports additional data through the fields parameter
Parameters
Label | Description | Values | Modifiers | Type | Required |
---|---|---|---|---|---|
id | The unique id of an account or accounts to access. e.g v1.3/accounts?id=2&id=1 |
an account "id" | none | query string | false |
fields | Return additional data about the accounts resouce e.g v1.3/accounts?fields=url,reports,id,channels |
url, reports, id, channels, description, package, created_date, name | none | query string | false |
Examples
Basic Example
> curl -u username:password "https://api.conversocial.com/v1.3/accounts"
# Response
{
"accounts": [
{
"id": "1",
"url": "https://api.conversocial.com/v1.3/accounts/1"
}, {
"id": "2",
"url": "https://api.conversocial.com/v1.3/accounts/2"
},
...
],
"paging": {
"prev_page": null,
"next_page": "https://api.conversocial.com/v1.3/accounts?limit=10&offset=10"
}
}
Example with additional fields
> curl -u username:password "https://api.conversocial.com/v1.3/accounts?fields=name,reports"
# Response
{
"accounts": [
{
"id": "1"
"name": "Enterprise Domain",
"url": "https://api.conversocial.com/v1.3/accounts/1",
"reports": "https://api.conversocial.com/v1.3/reports?account=1"
},
...
],
"paging": {
"prev_page": null,
"next_page": "https://api.conversocial.com/v1.3/accounts?limit=10&offset=10"
}
}
An account resouce
> curl -u username:password "https://api.conversocial.com/v1.3/accounts/2?fields=name,reports"
# Response
{
"accounts": [
{
"id": "1"
"name": "Enterprise Domain",
"url": "https://api.conversocial.com/v1.3/accounts/1",
"reports": "https://api.conversocial.com/v1.3/reports?account=1"
},
...
],
"paging": {
"prev_page": null,
"next_page": "https://api.conversocial.com/v1.3/accounts?limit=10&offset=10"
}
}