Contacts

Contacts are all the individual persons or organizations you are doing business with. Use the contacts API to list, create or update contacts within your Lancerkit account.

API endpoints

List contacts

GET https://api.lancerkit.com/contacts

List all the contacts on your account

Query Parameters

Name	Type	Description
search	String	A query to filter the contact list
page	Number

200: OK All the contacts matching your search

{
    // Response
}

Get a contact

GET https://api.lancerkit.com/contacts/:id

Get a specific contact from your account

Path Parameters

Name	Type	Description
id	String	The id of the contact

200: OK The specified document

{
    // Response
}

Delete contacts

DELETE https://api.lancerkit.com/contacts

Delete some contacts from your account

Request Body

Name	Type	Description
ids	String	The ids of the contacts to delete

200: OK The number of contacts deleted

{
    // Response
}

Edit a contact

POST https://api.lancerkit.com/contacts/:id

Edit an existing contact

Path Parameters

Name	Type	Description
id	String	The id of the contact

Request Body

Name	Type	Description
firstName	String
lastName	String
company	String
phone	String
email	String
vatNumber	String
country	String
city	String
zip	String
number	String
street	String

200: OK The edited contact

{
    // Response
}

Create a contact

POST https://api.lancerkit.com/contacts/new

Create a new contact

Request Body

Name	Type	Description
firstName	String
lastName	String
company	String
phone	String
email	String
vatNumber	String
country	String
city	String
zip	String
number	String
street	String

200: OK The created contact

{
    // Response
}