Get item list
Description
Retrieve a list of items
Url
1 |
GET /api/v0/item/ |
Parameters
optional
- name: filter by this exact match.
- name__contains: filter by case-sensitive containment.
- collection__uuid: filter by collection UUID.
- collection__name: filter by collection name, using this exact match.
- collection__name__contains: filter by collection name, using case-sensitive containment.
Example
Get all items
Request
1 |
curl 'https://my.craftar.net/api/v0/item/?api_key=123456789abcdefghijk123456789abcdefghijk' |
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
{ "objects": [ { "uuid": "4fe672886ec142f6ab6d72d54acf046f", "url": "http://en.wikipedia.org/wiki/Linux_Magazine", "resource_uri": "/api/v0/item/4fe672886ec142f6ab6d72d54acf046f/", "name": "Linux Magazine", "content": null, "collection": "/api/v0/collection/440c374d09424243b9448cd289545db1/" }, { "uuid": "a046a5f3fbe44399a95a0e8efe3fb8eb", "url": "http://en.wikipedia.org/wiki/Mona_Lisa", "resource_uri": "/api/v0/item/a046a5f3fbe44399a95a0e8efe3fb8eb/", "name": "Mona Lisa", "content": null, "collection": "/api/v0/collection/806e54535ffd464f83545c902e664aca/" } ], "meta": { "total_count": 2, "previous": null, "offset": 0, "next": null, "limit": 20 } } |
Get all items from the collection whose UUID is a046a5f3fbe44399a95a0e8efe3fb8eb
Request
1 |
curl 'https://my.craftar.net/api/v0/item/?api_key=123456789abcdefghijk123456789abcdefghijk&collection__uuid=806e54535ffd464f83545c902e664aca' |
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
{ "objects": [ { "uuid": "a046a5f3fbe44399a95a0e8efe3fb8eb", "url": "http://en.wikipedia.org/wiki/Mona_Lisa", "resource_uri": "/api/v0/item/a046a5f3fbe44399a95a0e8efe3fb8eb/", "name": "Mona Lisa", "content": null, "collection": "/api/v0/collection/806e54535ffd464f83545c902e664aca/" } ], "meta": { "total_count": 1, "previous": null, "offset": 0, "next": null, "limit": 20 } } |
Get all items from the collection whose UUID is a046a5f3fbe44399a95a0e8efe3fb8eb and whose name contains Mona
Request
1 |
curl 'https://my.craftar.net/api/v0/item/?api_key=123456789abcdefghijk123456789abcdefghijk&collection__uuid=806e54535ffd464f83545c902e664aca&name__contains=Mona' |
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
{ "objects": [ { "uuid": "a046a5f3fbe44399a95a0e8efe3fb8eb", "url": "http://en.wikipedia.org/wiki/Mona_Lisa", "resource_uri": "/api/v0/item/a046a5f3fbe44399a95a0e8efe3fb8eb/", "name": "Mona Lisa", "content": null, "collection": "/api/v0/collection/806e54535ffd464f83545c902e664aca/" } ], "meta": { "total_count": 1, "previous": null, "offset": 0, "next": null, "limit": 20 } } |