Credentials

A credential is used by LeadConduit's rich integrations to authenticate with third party platforms. Once a credential is established, it can be used across flows. A credential ID can be specified on a source in a flow or in recipient step's integration mappings.

List all credentials

Get the list of all credentials.

Responses
200

OK

get/credentials
Request samples
curl -i -X GET \
  https://app.leadconduit.com/credentials
Response samples
application/json
[
  • {
    • "id": "string",
    • "name": "string",
    • "type": "user",
    • "package": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "username": "string",
    • "password": "string"
    }
]

Create a new credential

Create a new credential

Request
Request Body schema: application/json

Create a new credential

One of:
name
required
string

Friendly name for this credential

type
required
string

The type of model changes were performed on: user, token, oauth

Value: "user"
package
required
string

The name of the LeadConduit integration package to which this credential belongs

username
required
string non-empty

The username to user for basic authentication

password
required
string non-empty

The password to user for basic authentication

property name*
any
Responses
201

Created

post/credentials
Request samples
application/json
{
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "username": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Get a credential

Returns the credential matching the specified ID

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the credential to get

Responses
200

OK

get/credentials/{id}
Request samples
curl -i -X GET \
  https://app.leadconduit.com/credentials/:id
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Update a credential

Update an existing credential matching the specified ID

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the credential to update

Request Body schema: application/json

Create a new credential

One of:
name
required
string

Friendly name for this credential

type
required
string

The type of model changes were performed on: user, token, oauth

Value: "user"
package
required
string

The name of the LeadConduit integration package to which this credential belongs

username
required
string non-empty

The username to user for basic authentication

password
required
string non-empty

The password to user for basic authentication

property name*
any
Responses
200

OK

put/credentials/{id}
Request samples
application/json
{
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "username": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Delete a credential

Deletes the credential matching the specified ID

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the credential to delete

Responses
200

OK

delete/credentials/{id}
Request samples
curl -i -X DELETE \
  https://app.leadconduit.com/credentials/:id
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}