Postman collection/ API

[Shamila Chathuranga]

Can I have a predefined API collection for Postman?
And can I have an example for custom API functions. All thing about write API with an example,

Looking for help I'm new to CRM and API too

Thank you very much!

[Shamila Chathuranga]

Anyone can explain how to work predefined API in CRM. it's working flow too.

I need to develop an external system with CRM data and Conditions.

[Vadym]

Hi Shamila,

There is not yet such a collection.
Perhaps, the following article may be useful:

https://docs.espocrm.com/development/api/#rest-api

[Shamila Chathuranga]

Thank you Vadym
I have already read this article and I have set up a postman also.

[emillod]

Hello Shamila Chathuranga
Here you have video tutorial how to setup connection through API client like postman and how to fetch details through API: https://www.youtube.com/watch?v=j6NZ41Uj7R8

[esforim]

You can also data collect it using your browser Console. There isn't a list of all the API but I think there is a system that is used. For example:

/api/v1/Contact

The "contact" here is the entity name.

If you are new to API I think don't you can learn it, I made quite a few post about API (trying to learn it myself but end up failing to make use of it).
emillod also made a good Tutorial using API too, I probably give that a try one day.

See a few post about API here:
https://github.com/o-data/EspoCRM-Le...i--integration

[Shamila Chathuranga]

Dear @espocrm

I have set up a postman.

I have tried different entity names all works well.
using "/api/v1/User" I can get all users but I need to get some users who have a specific team.
How to do it using API.

Thank you
Looking for help

[emillod]

Shamila Chathuranga

https://demo.espocrm.com/api/v1/User?maxSize=20&offset=0&orderBy=userName&order=asc&where%5B0%5D%5Btype%5D=linkedWith&where%5B0%5D%5Battribute%5D=teams&where%5B0%5D%5Bvalue%5D%5B%5D=52bd3ee937361

Here you have propper endpoint. Just replace domain and id with your team id. That's it.

[Shamila Chathuranga]

Hey Dear,

Thank all helping me Now all predefined API are found.
How can I write a custom API in CRM?
I mean write route, function, and all things about writing my own function in CRM

Looking for help

[Shamila Chathuranga]

I mean,

ex: http://test.com/espocrm/api/v1/Team_...ole_and_custom

Imagine there's no entity called 'Team_with_role_and_custom' but I need to get or post data using this URL

how to write route and where should I write route and where should I write my function

[emillod]

Here you have a documenation: https://docs.espocrm.com/development...nd/controller/

[esforim]

Not sure as this is out of my league but doing a search on api/v1 on the code give you these path/file/config - https://github.com/espocrm/espocrm/search?q=api%2Fv1

You can probably (I assume you know coding otherwise this going to be a learning experience) add addition api URL, or just change it totally (this will most likely break your system if you are not careful)

Other keyword you want to search for is "entrypoint" - https://github.com/espocrm/espocrm/search?q=entrypoint

Perhaps reading through some of the guide/tutorial to see how EspoCRM is design by telecastg might be the way to go and look at documentation.
If you don't have programming skill, I don't think you can get very far without investment in time and professional/education guidance.

[emillod]

esforim entryPoint will only process GET requests. If Shamilla want to send POST request, than it require controller from few versions of EspoCRM.

[esforim]

Thanks for the info emillod, but if you going to create a API, I'm sure at some point you need to do a "Get" as well. Bit odd if it only Post is created, which is OK for some situation

[emillod]

esforim controller can also receive get requests

[Shamila Chathuranga]

Hey guys,

Thank you for helping me lot

I have created API Nicely but I have some doubts from JSON response

It has a total of items 532,
but the array has only 200 records. I need to get all records in this array.
How to do it?

Thank you

[emillod]

Probably you have to read more about pagination.

https://docs.espocrm.com/development/api-search-params/#offset

[Shamila Chathuranga]

I have read this article but I didn't get it, pal.
Can you explain a bit?

I need all data in one array but it has given only 200 records.
How to set pagination properly.

This is my API:
{{url}}/Opportunity?select=serviceType%2CassignedUserId%2C assignedUserName%2CisActive&offset=0

[emillod]

This is propper way to fetch records, through offset param. Thanks to that requests can have big impact on performance. I don't know is there a way to skip pagination by any param in url. You could create controller which would generate array with all records, but i don't think it's a good idea.

[wtconseil]

Indeed, it could be awesome to have a PostMan public collection !

Here is the best example i have seen... it's Klaviyo API

https://www.postman.com/klaviyo/workspace/klaviyo-developers/collection/10773558-62af65e5-621f-4fff-9826-cab2261725fc

They maintain each API versioning.. with suitable examples.. that's amazing