Root

Say hello to our api (Public)

HTTP status code 200

Body

Type: application/xml

Example:

<?xml version="1.0" encoding="UTF-8"?>
<api>
  <name>Creads Partners API</name>
  <say>hello!</say>
  <version>1.0.0-beta7</version>
</api>

Type: application/json

Example:

{
  "name": "Creads Partners API"
  "say": "hello!",
  "version": "1.0.0-beta7
}

Batch

Batch request to execute several actions

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

Example:

[
  {
    "relative_url": "/v1/projects",
    "method": "POST",
    "body": "{\"title\":\"My title\"}"
  },
  {
    "relative_url": "/v1/projects/1234567891012",
    "method": "GET"
  }
]

Query Parameters

orderBy: (string - default: gid)
Order by field: weight
sort: (one of desc, asc - default: desc)
Order
query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: *title, description, gid *
Example:
```
["title", "==", "Web & Mobile"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see categories

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see categories"
  }
}

Products

Searchable and pageable collection of Products. As standard user you can only see enabled products for organization you are member of, As manager user, you can only see enabled products for organization you are manager of. And you can not create, update or delete a product.

/products get

get

Get a collection of products.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

orderBy: (string - default: gid)
Order by field: title, category.title, weight
sort: (one of desc, asc - default: desc)
Order
query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: *category.id, organizations.gid *
Example:
```
["category.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```
search: required (string)
A string containing terms or words to look for

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see products

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see products"
  }
}

/products/total_count get

Count number of products in collection

get

Count items in collection of total_count.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: *category.id, organizations.gid *
Example:
```
["category.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 3
}

HTTP status code 403

Your are not authorized to count items in collection of total_count

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to count items in collection of total_count"
  }
}

/products/{gid} get

get

Get product.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559befe84f871",
  "title": "Détourage photo",
  "available_options": {
    "mode": {
      "type": "string",
      "enum": ["solo", "multi"],
      "default": "solo",
      "required": true
    },
    "due": {
      "type": "integer",
      "enum": [1, 2, 7, 20],
      "default": 7,
      "required": true
    },
    "quantity": {
      "type": "integer",
      "default": 1,
      "required": false
    },
    "skill": {
      "type": "string",
      "enum": ["execution", "conception"],
      "default": "execution",
      "required": true
    },
  },
  "additional_meta" : {
    "solo_mode_meta": {
      "description": "",
      "brief_template": "Décrivez votre besoin, le contexte du projet, les livrables attendus..."
    },
    "multi_mode_meta": {
      "description": "",
      "brief_template": "Décrivez votre besoin, le contexte du projet, les livrables attendus..."
    }
  },
  "category": {
    "gid": "559befe84f871",
    "title": "lorem ipsum"
  },
  "interface": "default",
  "synonyms": [
    "Detourage photographie",
    "Montage de photo",
    "Incrustation photo"
  ]
}

HTTP status code 403

Your are not authorized to see this product

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this product"
  }
}

HTTP status code 404

Could not find this product

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this product"
  }
}

Projects

Searchable, pageable and orderable collection of projets. As standard user you can only see your own projects. As manager user, you can only see every projets for organizations you are manager of.

/projects get post

get

Get a collection of projects.

post

Create a new project

Get a collection of projects.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid, owner.gid, status, created_at, gid, short_code
Example:
```
["owner.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```
orderBy: (string - default: gid)
Order by field: created_at, modified_at, title, due_date
sort: (one of desc, asc - default: desc)
Order
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see projects

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see projects"
  }
}

Create a new project

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created project

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create project

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create project"
  }
}

/projects/total_count get

Count number of projects in collection

get

Count items in collection of total_count.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: owner, status
Example:
```
["owner", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 3
}

HTTP status code 403

Your are not authorized to count items in collection of total_count

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to count items in collection of total_count"
  }
}

/projects/{gid} get delete put

A project (submitted by partner to workers Available status :

draft
canceled
in_progress
finished (receipt need to be generated, user can give reviews on worker, waiting for sources, sources are downloadable)
paid

get

Get project.

delete

Delete a project. A project can be only deleted if its status is "draft"

put

Update a project. A project can be only updated if its status is "draft". Product can not be changed.

Get project.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559befeeab59f",
  "short_code": "Zd85moz",
  "href": "/project/559befeeab59f",
  "created_at": "2014-09-08T22:47:31-07:00",
  "modified_at": null,
  "published_at": "2014-09-09T22:47:31-07:00",
  "started_at": "2014-09-09T22:47:31-07:00",
  "status": "in_progress",
  "state": "published",
  "title": "Lorem ipsum dolor",
  "description": "<p>lorem ipsum</p> <strong>bold</strong> <em>emphsize</em> ",
  "price": {
    "amount": 1020.00,
    "currency": "EUR"
  },
  "options": {
    "mode": "solo",
    "due": 5,
    "quantity": 4
  },
  "product": {
    "gid": "559beff50d074",
    "title": "Logo"
  },
  "owner": {
    "gid": "559beff95ef1f",
    "firstname": "John",
    "lastname": "Doe"
  },
  "organization": {
    "gid": "559beffe2c12c"
  },
  "brief_files": [
    {
      "url": "https://cre.ads/43348e3ea6-1.zip",
    },
    {
      "url": "https://cre.ads/43348e3ea6-2.zip",
    },
    {
      "url": "https://cre.ads/43348e3ea6-3.zip"
    }
  ],
  "source_files": [
    {
      "url": "https://cre.ads/43348e3ea6-1.zip",
    },
    {
      "url": "https://cre.ads/43348e3ea6-2.zip",
    },
    {
      "url": "https://cre.ads/43348e3ea6-3.zip"
    }
  ],
  "deadline_at": "2014-09-14T22:47:31-07:00"
}

HTTP status code 403

Your are not authorized to see this project

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this project"
  }
}

HTTP status code 404

Could not find this project

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this project"
  }
}

Delete a project. A project can be only deleted if its status is "draft"

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 204

projects deleted

HTTP status code 403

Your are not authorized to delete this project

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to delete this projects"
  }
}

HTTP status code 404

Could not find this project

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this project"
  }
}

Update a project. A project can be only updated if its status is "draft". Product can not be changed.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 204

projects updated

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to update this projects

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to update this projects"
  }
}

HTTP status code 404

Could not find this projects

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this projects"
  }
}

/projects/{gid}/shared_with get post

get

Get the list of user with whom a given project is shared.

post

Share a project with a given user.

Get the list of user with whom a given project is shared.

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see shared_with

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see shared_with"
  }
}

Share a project with a given user.

Request
Response

URI Parameters

gid: required (string)

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created shared_with

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create shared_with

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create shared_with"
  }
}

/projects/{gid}/shared_with/{userGid} delete

delete

Unshare a project with a user.

/projects/{gid}/brief_files get post

get

Get a collection of brief_files.

post

Add a file as an attachment to the project

Get a collection of brief_files.

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see brief_files

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see brief_files"
  }
}

Add a file as an attachment to the project

Request
Response

URI Parameters

gid: required (string)

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created brief_file

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create brief_file

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create brief_file"
  }
}

/projects/{gid}/brief_files/{filepath} delete

delete

Remove a file from the attachments of the project

/projects/{gid}/messages get post

get

Get the list of message posted inside a project.

post

Post a new message to a project

Get the list of message posted inside a project.

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see messages

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see messages"
  }
}

Post a new message to a project

Request
Response

URI Parameters

gid: required (string)

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created message

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create message

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create message"
  }
}

/projects/{gid}/stat get

get

Get stats about given project

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see stat

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see stat"
  }
}

/projects/{gid}/files get

get

Get list of starred files among the project

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see files

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see files"
  }
}

Prices

Price resources for products in given organization.

/prices get

get

Get a collection of prices.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid, product.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see prices

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see prices"
  }
}

/prices/total_count get

Count number of prices in collection

get

Count items in collection of total_count.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid, product.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 3
}

HTTP status code 403

Your are not authorized to count items in collection of total_count

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to count items in collection of total_count"
  }
}

/prices/for get

Get price corresponding to project set (product, organization and options). It's an alias to search on /prices.

get

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

product.gid: required (string)
Current product gid

Example:
```
a615569f1e949b647ba10ed0adca790c
```
organization.gid: required (string)
Current organization gid

Example:
```
a615569f1e949b647ba10ed0adca790c
```
options.due: required (integer)
Choosen option value

Example:
```
1
```
options.mode: required (string)
Choosen option value

Example:
```
solo
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "product": {
    "gid": "774ad87f6fe7c9aa1eacc591e3307746"
  },
  "options": {
    "mode": "solo",
    "due": 7
  },
  "amount": 1020.00,
  "currency": "EUR"
}

/prices/{gid} get

Price for a product

get

Get price.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559befdd6cdd3",
  "created_at": "2014-09-08T22:47:31-07:00",
  "updated_at": null,
  "organization": {
    "gid": "559bf04ba85a5",
    "name": "Creads",
    "href": "/organization/559bf04ba85a5"
  },
  "product": {
    "gid": "559befe249b38"
  },
  "options": {
    "mode": "solo",
    "due": 7
  },
  "amount": 1020.00,
  "currency": "EUR"
}

HTTP status code 403

Your are not authorized to see this price

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this price"
  }
}

HTTP status code 404

Could not find this price

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this price"
  }
}

Works

Searchable, pageable and orderable collection of works. A standard user can not create a new work and can only see works related to its own projects.

/works get

get

Get a collection of works.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: worker.gid, project.gid, won_at, parent.gid, parent, gid, created_at
Example:
```
[["project.gid", "==", "a615569f1e949b647ba10ed0adca790c"], ["won_at", "!=", null], ["parent", "==", null]]
```
orderBy: (string - default: gid)
Order by field: created_at
sort: (one of desc, asc - default: desc)
Order
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see works

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see works"
  }
}

/works/{gid} get

Work done on a project. A standard user can not update or delete a work.

get

Get work.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bf0527764e",
  "created_at": "2014-09-08T22:47:31-07:00",
  "won_at": null,
  "description" : "Quisque ac ligula faucibus, pretium orci ac, porta velit. Cras ante enim, lacinia a commodo ut, iaculis et sem. Sed faucibus leo id justo imperdiet sollicitudin. Nunc tempor et risus vitae pulvinar. Quisque sed lacinia erat, vitae efficitur turpis. Fusce vel mollis tortor. Vivamus fermentum lacus in ultricies euismod.",
  "image": "https://cre.ads/43348e3ea6-1.jpg",
  "content": "Cogito Ergo Sum",
  "worker": {
    "gid": "559bf0683e9a5"
  },
  "project": {
    "gid": "559bf06dc73e8",
    "title": "lorem ipsum dolor"
  }
}

HTTP status code 403

Your are not authorized to see this work

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this work"
  }
}

HTTP status code 404

Could not find this work

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this work"
  }
}

Workers

Searchable collection of workers.

/workers get

get

Get a collection of workers.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: works.project.gid
Example:
```
[["works.project.gid", "==", "a615569f1e949b647ba10ed0adca790c"]]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see workers

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see workers"
  }
}

/workers/{gid} get

get

Get worker.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bf0683e9a5",
  "created_at": "2014-09-08T22:47:31-07:00",
  "creads_id" : "4",
  "firstname" : "Jack",
  "lastname" : "D.",
  "full_name" : "Jack D.",
  "avatar": "https://cre.ads/43348e3ea6-1.jpg"
}

HTTP status code 403

Your are not authorized to see this worker

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this worker"
  }
}

HTTP status code 404

Could not find this worker

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this worker"
  }
}

Comments

Generic comments system able to comment any REST resource (based on its relative URI). Standard user can not list every comments.

/comments get post

get

Get a collection of comments.

post

Create a new comment

Get a collection of comments.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: uri, author.gid, worker.gid, created_at, modified_at
Example:
```
["uri", "==", "/my-page"]
```
orderBy: (string - default: gid)
Order by field: created_at
sort: (one of desc, asc - default: desc)
Order
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see comments

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see comments"
  }
}

Create a new comment

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created comment

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create comment

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create comment"
  }
}

/comments/{gid} get delete put

get

Get comment.

delete

Delete resource comments.

put

Update resource comment

Get comment.

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bef42c09b7",
  "created_at": "2014-09-08T22:47:31-08:00",
  "modified_at": "2014-09-08T22:47:31-08:00",
  "author": {
    "gid": "559bef4a9b600"
  },
  "worker": null,
  "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras scelerisque viverra sodales. Vestibulum quis fringilla nisi. Donec congue neque ac consequat vestibulum. Praesent sed urna maximus ante ornare vestibulum. In in vulputate sapien. Ut elementum bibendum mi sit amet congue. Aliquam suscipit turpis vitae dapibus efficitur. Nullam quis lacinia ligula. Nam at lectus sem.",
  "mine": true,
  "uri": "/works/559bef4a9b600",
  "nickname": "Bernard L."
}

HTTP status code 403

Your are not authorized to see this comment

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this comment"
  }
}

HTTP status code 404

Could not find this comment

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this comment"
  }
}

Delete resource comments.

Request
Response

URI Parameters

gid: required (string)

HTTP status code 204

comments deleted

HTTP status code 403

Your are not authorized to delete this comment

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to delete this comments"
  }
}

HTTP status code 404

Could not find this comment

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this comment"
  }
}

Update resource comment

Request
Response

URI Parameters

gid: required (string)

Body

Type: application/json

HTTP status code 204

comments updated

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to update this comments

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to update this comments"
  }
}

HTTP status code 404

Could not find this comments

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this comments"
  }
}

Reviews

review resource collection. A standard user can only see review on its own project. A standard user can only create review for its own project.

/reviews get post

get

Get a collection of reviews.

post

Create a new review

Get a collection of reviews.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: worker.gid, project.gid
Example:
```
["worker.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see reviews

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see reviews"
  }
}

Create a new review

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created review

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create review

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create review"
  }
}

/reviews/{gid} get

review on a worker for a given project. A standard user can only see review on its own project. A standard user can not update or delete a review.

get

Get review.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bef51dbe8e",
  "quality": 4,
  "reactivity": 5,
  "communicativeness": 2,
  "work_with_again": 1,
  "comment": "did a great work on this project! Thanks",
  "project": {
    "gid": "559bef57975ff",
    "href": "/project/559bef57975ff"
  },
  "worker": {
    "gid": "559bef65432d7",
    "href": "/project/559bef65432d7"
  }
}

HTTP status code 403

Your are not authorized to see this review

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this review"
  }
}

HTTP status code 404

Could not find this review

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this review"
  }
}

Users

Orderable, Searchable and pageable collection of Users. As standard user, you can only see your user. As manager user, you can see, create, update and delete users for organizations you are manager of.

/users get

get

Get a collection of users.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: member_of.organization.gid, created_at, modified_at, gid
Example:
```
["member_of.organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```
orderBy: (string - default: gid)
Order by field: created_at, modified_at
sort: (one of desc, asc - default: desc)
Order

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see users

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see users"
  }
}

/users/total_count get

Count number of users in collection

get

Count items in collection of total_count.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: member_of.organization.gid, created_at, modified_at
Example:
```
["member_of.organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 3
}

HTTP status code 403

Your are not authorized to count items in collection of total_count

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to count items in collection of total_count"
  }
}

/users/{gid} get

get

Get user.

Request
Response

URI Parameters

gid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bf015e3af0",
  "href": "/user/559bf015e3af0",
  "created_at": "2014-09-08T22:47:31-08:00",
  "modified_at": null,
  "firstname": "John",
  "lastname": "Doe",
  "roles": ["customer"],
  "email": "john.doe@gmail.com",
  "phone": "+33102030405",
  "mobile": "+33602030405",
  "locale": "fr_FR",
  "member_of": [
    {
      "organization": {
        "gid": "559bf04ba85a5",
        "name": "Creads",
        "href": "/organization/559bf04ba85a5"
      },
      "monthly_budget": {
        "amount": 2000,
        "currency": "EUR"
      },
      "monthly_spent": {
        "amount": 200,
        "currency": "EUR"
      },
      "is_manager": false
    }
  ],
  "roles": [
    "user"
  ]
}

HTTP status code 403

Your are not authorized to see this user

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this user"
  }
}

HTTP status code 404

Could not find this user

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this user"
  }
}

/users/{gid}/member_of get

get

Get a collection of member_of.

Request
Response

URI Parameters

gid: required (string)

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see member_of

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see member_of"
  }
}

/users/{gid}/member_of/{orgaGid} get

get

Get member_of.

Request
Response

URI Parameters

gid: required (string)
orgaGid: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bf015e3af0",
  "organization": {
    "gid": "559bf04ba85a5",
    "name": "Creads",
    "href": "/organization/559bf04ba85a5"
  },
  "monthly_budget": {
    "amount": 2000,
    "currency": "EUR"
  },
  "monthly_spent": {
    "amount": 200,
    "currency": "EUR",
  },
  "is_manager": false
}

HTTP status code 403

Your are not authorized to see this member_of

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this member_of"
  }
}

HTTP status code 404

Could not find this member_of

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this member_of"
  }
}

Invitations

Invitations to create user account or add to organization existing user.

/invitations get post

get

Get a collection of invitations.

post

Create a new invitation

Get a collection of invitations.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see invitations

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see invitations"
  }
}

Create a new invitation

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created invitation

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create invitation

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create invitation"
  }
}

/invitations/{gid} get delete

A specific invitation

get

Get invitation.

delete

Delete resource <<resourcePathName>>.

Get invitation.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bef42c09b7",
  "created_at": "2014-09-08T22:47:31-08:00",
  "modified_at": "2014-09-08T22:47:31-08:00",
  "href": "/invitations/559bef42c09b7",
  "token": "559bef42c09b7559bef42c09b7559bef42c09b7",
  "has_user": false,
  "email": "john.doe@test.fr"
}

HTTP status code 403

Your are not authorized to see this invitation

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this invitation"
  }
}

HTTP status code 404

Could not find this invitation

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this invitation"
  }
}

Delete resource <<resourcePathName>>.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 204

<<resourcePathName>> deleted

HTTP status code 403

Your are not authorized to delete this <<resourcePathName | !singularize>>

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to delete this <<resourcePathName>>"
  }
}

HTTP status code 404

Could not find this <<resourcePathName | !singularize>>

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this <<resourcePathName | !singularize>>"
  }
}

Me

Current logged User. Alias for /user/{gid} Will throw 403 if authenticated with client_creadentials

/me get put

get

Get me.

put

Update current user

Get me.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

fields: (string)
If set, the endpoint will only return the requested fields of the entity (plus the generic ones) Comma separated values: field1,field2,field3

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559bf015e3af0",
  "href": "/user/559bf015e3af0",
  "created_at": "2014-09-08T22:47:31-08:00",
  "modified_at": null,
  "firstname": "John",
  "lastname": "Doe",
  "roles": ["customer"],
  "email": "john.doe@gmail.com",
  "phone": "+33102030405",
  "mobile": "+33602030405",
  "locale": "fr_FR",
  "member_of": [
    {
      "organization": {
        "gid": "559bf04ba85a5",
        "name": "Creads",
        "href": "/organization/559bf04ba85a5"
      },
      "monthly_budget": {
        "amount": 2000,
        "currency": "EUR"
      },
      "monthly_spent": {
        "amount": 200,
        "currency": "EUR"
      },
      "is_manager": false
    }
  ],
  "roles": [
    "user"
  ]
}

HTTP status code 403

Your are not authorized to see this me

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this me"
  }
}

HTTP status code 404

Could not find this me

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this me"
  }
}

Update current user

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

fields: (string)
If set, the endpoint will only return the requested fields of the entity (plus the generic ones) Comma separated values: field1,field2,field3

Body

Type: application/json

HTTP status code 204

current user updated

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

/me/member_of get

Alias for /user/{gid}/member_of Will throw 403 if authenticated with client_creadentials

get

Get a collection of member_of.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see member_of

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see member_of"
  }
}

Organizations

Searchable and pageable collection of Organizations. As standard or manager user, you can only see your organizations.

/organizations get

get

Get a collection of organizations.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

orderBy: (string - default: gid)
Order by field: modified_at, name, parent.name
sort: (one of desc, asc - default: desc)
Order
query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: products.gid, modified_at
Example:
```
["products.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see organizations

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see organizations"
  }
}

/organizations/{gid} get

get

Get organization.

Request
Response

URI Parameters

gid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "559befd82c88b",
  "created_at": {
    "type": "string",
    "format": "date-time",
    "readOnly": true,
    "required": true
  },
  "href": {
    "type": "string",
    "readOnly": true,
    "required": true
  },
  "name": "Creads",
  "hostname": "partners-creads.fr",
  "vat": "FR09504019662",
  "billing_address": {
    "division": null,
    "address1": "112 Rue de Réaumur",
    "address2": null,
    "zipcode": "75012",
    "city": "Paris",
    "state": null,
    "country": "FR",
    "additional": null,
  },
  "billing_contact": {
    "phone": null,
    "email": "contact@email.com"
  },
  "logo": "https://cre.ads/43348e3ea6-1.jpg"
}

HTTP status code 403

Your are not authorized to see this organization

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this organization"
  }
}

HTTP status code 404

Could not find this organization

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this organization"
  }
}

/organizations/{gid}/prices/fetch get

get

Gives order to import prices from Google Spreadsheet if its configured for the organization

Organizations (shorthand)

/orgs/{orgGid}/member_of get

get

Get a collection of member_of.

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see member_of

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see member_of"
  }
}

/orgs/{orgGid}/payment_source get delete put post

get

The payment method associated to the organization

delete

Delete resource payment_source.

put

Update resource payment_source

post

Add (or replace) a payment method to the organization

The payment method associated to the organization

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "gid": "1234567891012",
  "created_at": "2018-10-16T22:47:31-08:00",
  "modified_at": "2018-10-16T22: 47: 31-08: 00",
  "rid": "external_api_source_id",
  "reference": "JOEHF9F7DOXAA07F",
  "last_digits": "1234"
}

HTTP status code 403

Your are not authorized to see this payment_source

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see this payment_source"
  }
}

HTTP status code 404

Could not find this payment_source

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not find this payment_source"
  }
}

Delete resource payment_source.

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 204

payment_source deleted

HTTP status code 403

Your are not authorized to delete this payment_source

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to delete this payment_source"
  }
}

HTTP status code 404

Could not find this payment_source

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this payment_source"
  }
}

Update resource payment_source

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 204

payment_source updated

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to update this payment_source

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to update this payment_source"
  }
}

HTTP status code 404

Could not find this payment_source

Body

Type: application/json

Example:

{
  "error": {
    "code": 404,
    "message" : "Could not this payment_source"
  }
}

/orgs/{orgGid}/credit_notes get

get

The Credit Notes of the organization

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see credit_notes

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see credit_notes"
  }
}

/orgs/{orgGid}/webhooks get post

get

The webhooks associated to the organization

post

Add a webhook to the organization

The webhooks associated to the organization

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see webhooks

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see webhooks"
  }
}

Add a webhook to the organization

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Body

Type: application/json

HTTP status code 201

Headers

Location: required (string)
Location of the newly created webhook

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

HTTP status code 403

Your are not authorized to create webhook

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to create webhook"
  }
}

/orgs/{orgGid}/webhooks/check post

post

Trigger a void event to test a potential webhook

/orgs/{orgGid}/webhooks/{webhookGid} put delete

put

Edit a webhook

delete

Delete a webhook

/orgs/{orgGid}/products get

Available products for the current organization

get

Get a collection of products.

Request
Response

URI Parameters

orgGid: required (string)

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

search: required (string)
A string containing terms or words to look for

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see products

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see products"
  }
}

/orgs/{orgGid}/users

Search users among an organization from a string query

Public

Publicly accessible resources

/p/invitations/{token} get

get

Gets the invitation (whether it creates a new user or not)

Request
Response

URI Parameters

token: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "has_user": true
}

/p/invitations/user post

post

Create a user using invitation token

Request
Response

Body

Type: application/json

HTTP status code 204

user created

HTTP status code 400

Data missing or invalid

Body

Type: application/json

Example:

{
  "error": {
    "code": 400,
    "message" : "Data missing or invalid"
  }
}

Files

/files/{url} get

get

Generate a signed URL (or renew an old one) to get a file. {url} parameter can be relative, absolute not signed or absolute signed. For instance, following values are valid :

File Info

/fileinfo/{url} get

get

Get informations about a file.

Request
Response

URI Parameters

url: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "size":8087048,
  "mime_type":"application/pdf",
  "created_at":"2016-11-29T08:31:31+0000",
  "modified_at":"2016-11-29T08:31:29+0000"
}

Receipts

Searchable, pageable and orderable collection of receipts. As standard user you can only see your own receipts. As manager user, you can only see every receipts for organizations you are manager of.

/receipts get

get

Get a collection of receipts.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid, user.gid, project.gid, gid
Example:
```
["user.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```
orderBy: (string - default: gid)
Order by field: created_at
sort: (one of desc, asc - default: desc)
Order
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see receipts

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see receipts"
  }
}

Invoices

Searchable, pageable and orderable collection of invoices. As standard user you cant see any invoice. As a owner of an organization, you can only see every invoice for your organization.

/invoices get

get

Get a collection of invoices.

Request
Response

Headers

Authorization: required (string)
Authorization: Bearer TOKEN

See https://auth0.com/blog/2014/01/07/angularjs-authentication-with-cookies-vs-token/

Query Parameters

query: (string)
JSON array: *[["field1","operator1","value1"], ["field2","operator2","value2"], ..., ["fieldN","operatorN","valueN"]]*
- Valid operators: ==, !=, like, >, <, >=, <=
- Valid searchable fields: organization.gid
Example:
```
["organization.gid", "==", "a615569f1e949b647ba10ed0adca790c"]
```
orderBy: (string - default: gid)
Order by field: created_at
sort: (one of desc, asc - default: desc)
Order
offset: (integer)
Skip over a number of elements by specifying an offset value for the query

Example:
```
20
```
limit: (integer - default: 10)
Limit the number of elements on the response

Example:
```
80
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "total_count": 0,
  "items": []
}

HTTP status code 403

Your are not authorized to see invoices

Body

Type: application/json

Example:

{
  "error": {
    "code": 403,
    "message" : "Your are not authorized to see invoices"
  }
}

Starred files

Allows filepaths (already uploaded) to be marked as starred. Only supported (visible) for project messages attachments for now.

/files post

post

Mark a file as starred

/files/{filepath} delete

delete

Références API

Root

get /

HTTP status code 200

Body

Batch

post /batch

Headers

Body

Categories

get /categories

Query Parameters

HTTP status code 200

Body

HTTP status code 403

Body

Products

get /products

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 403

Body

get /products/total_count

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 403

Body

get /products/{gid}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 404

Body

Projects

get /projects

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 403

Body

post /projects

Headers

Body

HTTP status code 201

Headers

HTTP status code 400

Body

HTTP status code 403

Body

get /projects/total_count

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 403

Body

get /projects/{gid}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 404

Body

delete /projects/{gid}

URI Parameters

Headers

HTTP status code 204

HTTP status code 403

Body

HTTP status code 404