Apideck.IssueTracking

Class Name

IssueTrackingApi

Methods

List Tags
Create Comment
List Comments
Delete Comment
Get Comment
Update Comment
Create Ticket
List Tickets
Delete Ticket
Get Ticket
Update Ticket
List Users
Get User
List Collections
Get Collection

List Tags

Method: collectionTagsAll

issueTrackingApi.collectionTagsAll(body)

Parameters

Name	Type	Description	Notes
collectionId	[string]	The collection ID
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCollectionTagsResponse

HTTP response details

Status code	Description
200	List Tags
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example'
}

try {
  const { data } = await apideck.issueTracking.collectionTagsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Create Comment

Method: ticketCommentsAdd

issueTrackingApi.ticketCommentsAdd(body)

Parameters

Name	Type	Description	Notes
ticketComment	CollectionTicketComment
collectionId	[string]	The collection ID
ticketId	[string]	ID of the ticket you are acting upon.
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)

Response Type

CreateCommentResponse

HTTP response details

Status code	Description
201	Create a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example',
  ticketId: 'ticket_id_example',
  ticketComment: {
    body: 'What internet provider do you use?',
    pass_through: [
      {
        service_id: 'string',
        operation_id: 'string',
        extend_object: {},
        extend_paths: [
          {
            path: '$.nested.property',
            value: [Object]
          }
        ]
      }
    ]
  }
}

try {
  const { data } = await apideck.issueTracking.ticketCommentsAdd(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Comments

Method: ticketCommentsAll

issueTrackingApi.ticketCommentsAll(body)

Parameters

Name	Type	Description	Notes
collectionId	[string]	The collection ID
ticketId	[string]	ID of the ticket you are acting upon.
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
sort	CommentsSort	Apply sorting	(optional)
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCommentsResponse

HTTP response details

Status code	Description
200	List Comments
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example',
  ticketId: 'ticket_id_example'
}

try {
  const { data } = await apideck.issueTracking.ticketCommentsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Delete Comment

Method: ticketCommentsDelete

issueTrackingApi.ticketCommentsDelete(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
collectionId	[string]	The collection ID
ticketId	[string]	ID of the ticket you are acting upon.
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

DeleteCommentResponse

HTTP response details

Status code	Description
200	Delete a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  id: 'id_example',
  collectionId: 'collection_id_example',
  ticketId: 'ticket_id_example'
}

try {
  const { data } = await apideck.issueTracking.ticketCommentsDelete(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Comment

Method: ticketCommentsOne

issueTrackingApi.ticketCommentsOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
collectionId	[string]	The collection ID
ticketId	[string]	ID of the ticket you are acting upon.
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCommentResponse

HTTP response details

Status code	Description
200	Get a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  id: 'id_example',
  collectionId: 'collection_id_example',
  ticketId: 'ticket_id_example'
}

try {
  const { data } = await apideck.issueTracking.ticketCommentsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Update Comment

Method: ticketCommentsUpdate

issueTrackingApi.ticketCommentsUpdate(body)

Parameters

Name	Type	Description	Notes
ticketComment	CollectionTicketComment
id	[string]	ID of the record you are acting upon.
collectionId	[string]	The collection ID
ticketId	[string]	ID of the ticket you are acting upon.
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

UpdateCommentResponse

HTTP response details

Status code	Description
200	Update a Comment
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  id: 'id_example',
  collectionId: 'collection_id_example',
  ticketId: 'ticket_id_example',
  ticketComment: {
    body: 'What internet provider do you use?',
    pass_through: [
      {
        service_id: 'string',
        operation_id: 'string',
        extend_object: {},
        extend_paths: [
          {
            path: '$.nested.property',
            value: [Object]
          }
        ]
      }
    ]
  }
}

try {
  const { data } = await apideck.issueTracking.ticketCommentsUpdate(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Create Ticket

Method: ticketsAdd

issueTrackingApi.ticketsAdd(body)

Parameters

Name	Type	Description	Notes
ticket	Ticket
collectionId	[string]	The collection ID
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)

Response Type

CreateTicketResponse

HTTP response details

Status code	Description
201	Create a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example',
  ticket: {
    parent_id: '12345',
    type: 'Technical',
    subject: 'Technical Support Request',
    description: 'I am facing issues with my internet connection',
    status: 'open',
    priority: 'high',
    assignees: [
      {
        id: '12345'
      }
    ],
    due_date: '2020-09-30T07:43:32.000Z',
    tags: [
      {
        id: '12345'
      }
    ],
    pass_through: [
      {
        service_id: 'string',
        operation_id: 'string',
        extend_object: {},
        extend_paths: [
          {
            path: '$.nested.property',
            value: [Object]
          }
        ]
      }
    ]
  }
}

try {
  const { data } = await apideck.issueTracking.ticketsAdd(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Tickets

Method: ticketsAll

issueTrackingApi.ticketsAll(body)

Parameters

Name	Type	Description	Notes
collectionId	[string]	The collection ID
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
sort	TicketsSort	Apply sorting	(optional)
filter	IssuesFilter	Apply filters	(optional)
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetTicketsResponse

HTTP response details

Status code	Description
200	List Tickets
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example'
}

try {
  const { data } = await apideck.issueTracking.ticketsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Delete Ticket

Method: ticketsDelete

issueTrackingApi.ticketsDelete(body)

Parameters

Name	Type	Description	Notes
ticketId	[string]	ID of the ticket you are acting upon.
collectionId	[string]	The collection ID
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

DeleteTicketResponse

HTTP response details

Status code	Description
200	Delete a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  ticketId: 'ticket_id_example',
  collectionId: 'collection_id_example'
}

try {
  const { data } = await apideck.issueTracking.ticketsDelete(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Ticket

Method: ticketsOne

issueTrackingApi.ticketsOne(body)

Parameters

Name	Type	Description	Notes
ticketId	[string]	ID of the ticket you are acting upon.
collectionId	[string]	The collection ID
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetTicketResponse

HTTP response details

Status code	Description
200	Get a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  ticketId: 'ticket_id_example',
  collectionId: 'collection_id_example'
}

try {
  const { data } = await apideck.issueTracking.ticketsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Update Ticket

Method: ticketsUpdate

issueTrackingApi.ticketsUpdate(body)

Parameters

Name	Type	Description	Notes
ticket	Ticket
ticketId	[string]	ID of the ticket you are acting upon.
collectionId	[string]	The collection ID
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

UpdateTicketResponse

HTTP response details

Status code	Description
200	Update a Ticket
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  ticketId: 'ticket_id_example',
  collectionId: 'collection_id_example',
  ticket: {
    parent_id: '12345',
    type: 'Technical',
    subject: 'Technical Support Request',
    description: 'I am facing issues with my internet connection',
    status: 'open',
    priority: 'high',
    assignees: [
      {
        id: '12345'
      }
    ],
    due_date: '2020-09-30T07:43:32.000Z',
    tags: [
      {
        id: '12345'
      }
    ],
    pass_through: [
      {
        service_id: 'string',
        operation_id: 'string',
        extend_object: {},
        extend_paths: [
          {
            path: '$.nested.property',
            value: [Object]
          }
        ]
      }
    ]
  }
}

try {
  const { data } = await apideck.issueTracking.ticketsUpdate(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Users

Method: collectionUsersAll

issueTrackingApi.collectionUsersAll(body)

Parameters

Name	Type	Description	Notes
collectionId	[string]	The collection ID
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCollectionUsersResponse

HTTP response details

Status code	Description
200	Users
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example'
}

try {
  const { data } = await apideck.issueTracking.collectionUsersAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get User

Method: collectionUsersOne

issueTrackingApi.collectionUsersOne(body)

Parameters

Name	Type	Description	Notes
collectionId	[string]	The collection ID
id	[string]	ID of the record you are acting upon.
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCollectionUserResponse

HTTP response details

Status code	Description
200	User
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example',
  id: 'id_example'
}

try {
  const { data } = await apideck.issueTracking.collectionUsersOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Collections

Method: collectionsAll

issueTrackingApi.collectionsAll(body)

Parameters

Name	Type	Description	Notes
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
sort	CollectionsSort	Apply sorting	(optional)
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCollectionsResponse

HTTP response details

Status code	Description
200	List Collections
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {}

try {
  const { data } = await apideck.issueTracking.collectionsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Collection

Method: collectionsOne

issueTrackingApi.collectionsOne(body)

Parameters

Name	Type	Description	Notes
collectionId	[string]	The collection ID
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetCollectionResponse

HTTP response details

Status code	Description
200	Get a Collection
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  collectionId: 'collection_id_example'
}

try {
  const { data } = await apideck.issueTracking.collectionsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Files

IssueTrackingApi.md

Latest commit

History

IssueTrackingApi.md

File metadata and controls

Apideck.IssueTracking

Class Name

Methods

List Tags

Parameters

Response Type

HTTP response details

Example Usage

Create Comment

Parameters

Response Type

HTTP response details

Example Usage

List Comments

Parameters

Response Type

HTTP response details

Example Usage

Delete Comment

Parameters

Response Type

HTTP response details

Example Usage

Get Comment

Parameters

Response Type

HTTP response details

Example Usage

Update Comment

Parameters

Response Type

HTTP response details

Example Usage

Create Ticket

Parameters

Response Type

HTTP response details

Example Usage

List Tickets

Parameters

Response Type

HTTP response details

Example Usage

Delete Ticket

Parameters

Response Type

HTTP response details

Example Usage

Get Ticket

Parameters

Response Type

HTTP response details

Example Usage

Update Ticket

Parameters

Response Type

HTTP response details

Example Usage

List Users

Parameters

Response Type

HTTP response details

Example Usage

Get User

Parameters

Response Type

HTTP response details

Example Usage

List Collections

Parameters

Response Type

HTTP response details

Example Usage

Get Collection