REI Software

REI Software Help Library

Search for any help questions or topics.

Task API

O
Orlando
Updated 3 years ago

Task

 

GET/v1/contacts/:contactId/tasks/

https://rest.reisoftware.com/v1/contacts/:contactId/tasks/

Get all contact tasks.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tasks/' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "tasks": [

    {

      "id": "Lj371SHlVMyfVlMcKiuk",

      "title": "Loram ipsum",

      "description": "Loram ipsum",

      "assignedTo": "hxHGVRb1YJUscrCB8eXK",

      "dueDate": "2020-10-25T11:00:00Z",

      "isCompleted": false

    },

    {

POST/v1/contacts/:contactId/tasks/

https://rest.reisoftware.com/v1/contacts/:contactId/tasks/

Create Tasks.


Status: (optional) Field have following options.


  • completed

  • incompleted (default)


Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

BODYraw

{

    "title": "First Task",

    "dueDate": "2020-10-25T11:00:00Z",

    "description": "loram ipsum",

    "assignedTo": "hxHGVRb1YJUscrCB8eXK",

    "status": "incompleted"

}

 

 

Successful response

Example Request

curl --location --request POST 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tasks/' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "title": "First Task",

    "dueDate": "2020-10-25T11:00:00Z",

    "description": "loram ipsum",

    "assignedTo": "hxHGVRb1YJUscrCB8eXK",

    "status": "incompleted"

}'

Example Response

200 OK

BodyHeader(1)

{

  "id": "Lj371SHlVMyfVlMcKiuk",

  "title": "Loram ipsum",

  "description": "Loram ipsum",

  "assignedTo": "hxHGVRb1YJUscrCB8eXK",

  "dueDate": "2020-10-25T11:00:00Z",

  "isCompleted": false

}

GET/v1/contacts/:contactId/tasks/:taskId

https://rest.reisoftware.com/v1/contacts/:contactId/tasks/:taskId

Get task by id.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

taskId

ocQHyuzHvysMo5N5VsXc

(Required) Task Id

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tasks/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

{

  "id": "Lj371SHlVMyfVlMcKiuk",

  "title": "Loram ipsum",

  "description": "Loram ipsum",

  "assignedTo": "hxHGVRb1YJUscrCB8eXK",

  "dueDate": "2020-10-25T11:00:00Z",

  "isCompleted": false

}

PUT/v1/contacts/:contactId/tasks/:taskId

https://rest.reisoftware.com/v1/contacts/:contactId/tasks/:taskId

Update Task.


Status: (optional) Field have following options.


  • completed

  • incompleted (default)


Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

taskId

ocQHyuzHvysMo5N5VsXc

(Required) Task Id

BODYraw

{

    "title": "First Task",

    "dueDate": "2020-10-25T11:00:00Z",

    "description": "loram ipsum",

    "assignedTo": "hxHGVRb1YJUscrCB8eXK",

    "status": "incompleted"

}

 

 

Successful response

Example Request

curl --location --request PUT 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tasks/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "title": "First Task",

    "dueDate": "2020-10-25T11:00:00Z",

    "description": "loram ipsum",

    "assignedTo": "hxHGVRb1YJUscrCB8eXK",

    "status": "incompleted"

}'

Example Response

200 OK

BodyHeader(1)

{

  "id": "Lj371SHlVMyfVlMcKiuk",

  "title": "Loram ipsum",

  "description": "Loram ipsum",

  "assignedTo": "hxHGVRb1YJUscrCB8eXK",

  "dueDate": "2020-10-25T11:00:00Z",

  "isCompleted": false

}

DEL/v1/contacts/:contactId/tasks/:taskId

https://rest.reisoftware.com/v1/contacts/:contactId/tasks/:taskId

Delete one of Task.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

taskId

ocQHyuzHvysMo5N5VsXc

(Required) Task Id

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tasks/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

""

PUT/v1/contacts/:contactId/tasks/:taskId/status

https://rest.reisoftware.com/v1/contacts/:contactId/tasks/:taskId/status

Update Task status.


Status: Field have following option


  • completed

  • incompleted


Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

taskId

ocQHyuzHvysMo5N5VsXc

(Required) Task Id

BODYraw

{

    "status": "completed"

}

 

 

Successful response

Example Request

curl --location --request PUT 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tasks/ocQHyuzHvysMo5N5VsXc/status' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "status": "completed"

}'

Example Response

200 OK

BodyHeader(1)

{

  "id": "Lj371SHlVMyfVlMcKiuk",

  "title": "Loram ipsum",

  "description": "Loram ipsum",

  "assignedTo": "hxHGVRb1YJUscrCB8eXK",

  "dueDate": "2020-10-25T11:00:00Z",

  "isCompleted": false

}

😞 😐 😃