List Item Services¶
This endpoint returns a list of available item services.
Request¶
GET https://v2.api.uberflip.com/metadata/items/services
Response¶
The response will contain a item service collection:
Body Parameters | Type | Description |
---|---|---|
data | Array | The collection of item services |
meta | Object | See: Pagination |
Each item service in the collection will have properties:
Body Parameters | Type | Description |
---|---|---|
code | String | The service code uniquely identifying the service |
full_name | String | The service full name |
short_name | String | The service short name |
type_code | String | The type code identifying the type (category) of the service (e.g. “social”) |
item_count | Integer | The number of items associated with the service |
Each item service has two names. full_name
contains the name of the company or product that
created or hosts the item (e.g. "Facebook Post"
), while short_name
does not (e.g.
"Post"
). Neither name is guaranteed to be unique, but of the two names full_name
is
least ambiguous.
Examples¶
curl -H "Authorization: Bearer [Token]" \
-i https://v2.api.uberflip.com/metadata/items/services
Sample response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"code": "blogpost",
"type_code": "blogs",
"short_name": "Article",
"full_name": "Blog Article",
"item_count": 75
},
{
"code": "brightcove",
"type_code": "videos",
"short_name": "Video",
"full_name": "Brightcove Video",
"item_count": 0
},
{
"code": "facebook",
"type_code": "social",
"short_name": "Post",
"full_name": "Facebook Post",
"item_count": 0
},
...
],
"meta": {
...
}
}